/*
 * ------------------------------------------------------------------------
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ------------------------------------------------------------------------
 */
package org.knime.base.node.preproc.transpose;

import org.knime.core.node.defaultnodesettings.DefaultNodeSettingsPane;
import org.knime.core.node.defaultnodesettings.DialogComponentButtonGroup;
import org.knime.core.node.defaultnodesettings.DialogComponentNumber;
import org.knime.core.node.defaultnodesettings.SettingsModelIntegerBounded;
import org.knime.core.node.defaultnodesettings.SettingsModelString;

/**
 *
 * @author Thomas Gabriel, University of Konstanz
 */
public class TransposeTableNodeDialogPane extends DefaultNodeSettingsPane {

    static final String OPTION_GUESS_CHUNK_SIZE = "Guess chunk size based on available memory";

    static final String OPTION_FIXED_CHUNK_SIZE = "Use fixed chunk size (columns)";

    /**
     * Create new dialog with option to set number of columns to chunk.
     */
    TransposeTableNodeDialogPane() {
        // add ButtonGroup for mode selection (auto-determine chunk size vs. fixed)
        final var chunkSizeChooserModel = createChunkSizeChooserModel();
        super.addDialogComponent(new DialogComponentButtonGroup(chunkSizeChooserModel, true, null,
            OPTION_GUESS_CHUNK_SIZE, OPTION_FIXED_CHUNK_SIZE));

        // add actual chunk size selector
        super.addDialogComponent(new DialogComponentNumber(createChunkSizeModel(chunkSizeChooserModel), "Chunk size: ", 10));
    }

    /**
     * Creates the SettingsModel for selecting a certain String.
     * This selection will happen via the ButtonGroup instantiated in the constructor.
     *
     * @return SettingsModelString for guess-chunk-size mode
     */
    static final SettingsModelString createChunkSizeChooserModel() {
        return new SettingsModelString("guess_or_fixed", OPTION_GUESS_CHUNK_SIZE);
    }

    /**
     * Creates the SettingsModelIntegerBounded for storing the fixed chunk size value.
     * This number selector is only enabled if the option
     *
     * @param chunkSizeChooserModel condition for activating this number selector field
     * @return SettingsModelNumber for value of chunk size FIXED_CHUNK_SIZE is selected in the ButtonGroup.
     */
    static final SettingsModelIntegerBounded createChunkSizeModel(final SettingsModelString chunkSizeChooserModel) {
        final var chunkSizeModel = new SettingsModelIntegerBounded("chunk_size", 10, 1, Integer.MAX_VALUE);
        chunkSizeChooserModel.addChangeListener(
            e -> chunkSizeModel.setEnabled(chunkSizeChooserModel.getStringValue().equals(OPTION_FIXED_CHUNK_SIZE)));
        chunkSizeModel.setEnabled(false);
        return chunkSizeModel;
    }

}
